package org.dromara.common.core.utils.sql;

import lombok.AccessLevel;
import lombok.NoArgsConstructor;
import org.dromara.common.core.utils.StringUtils;


/**
 * @Author 刘武贵
 * @Date 2024/8/15 22:00
 * @Description 功能描述：sql操作工具类
 */
@NoArgsConstructor(access = AccessLevel.PRIVATE)
public class SqlUtil {

    /**
     * 定义常用的 sql关键字
     */
    public static final String SQL_REGEX = "select |insert |delete |update |drop |count |exec |chr |mid |master |truncate |char |and |declare ";

    /**
     * 仅支持字母、数字、下划线、空格、逗号、小数点（支持多个字段排序）
     */
    public static final String SQL_PATTERN = "[a-zA-Z0-9_\\ \\,\\.]+";

    /**
     * 检查字符，防止注入绕过
     */
    public static String escapeOrderBySql(String value) {
        if (StringUtils.isNotEmpty(value) && !isValidOrderBySql(value)) {
            throw new IllegalArgumentException("参数不符合规范，不能进行查询");
        }
        return value;
    }

    /**
     * 验证 order by 语法是否符合规范
     */
    public static boolean isValidOrderBySql(String value) {
        return value.matches(SQL_PATTERN);
    }

    /**
     * SQL关键字检查
     * 过滤敏感关键词，防止SQL注入
     *
     * 该方法旨在检查输入字符串中是否包含SQL注入风险的关键词如果发现包含任何敏感关键词，则抛出异常
     *
     * @param value 待检查的输入字符串
     * @throws IllegalArgumentException 如果输入字符串中包含SQL注入风险的关键词
     */
    public static void filterKeyword(String value) {
        // 检查输入字符串是否为空，为空则直接返回，避免不必要的处理
        if (StringUtils.isEmpty(value)) {
            return;
        }
        // 使用正则表达式分割出所有SQL注入风险关键词
        // 这里，SQL_REGEX是一个预定义的包含潜在SQL注入关键词的正则表达式
        String[] sqlKeywords = StringUtils.split(SQL_REGEX, "\\|");

        // 遍历所有分割出的关键词，检查输入字符串中是否包含这些关键词
        // 检查是不区分大小写的，以确保更高的安全性
        for (String sqlKeyword : sqlKeywords) {
            if (StringUtils.indexOfIgnoreCase(value, sqlKeyword) > -1) {
                throw new IllegalArgumentException("参数存在SQL注入风险");
            }
        }
    }
}
